change logs guide #919
change logs guide #919
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| It also assumes you have the [`jq` tool installed](https://jqlang.org/download/), | ||
| to perform lightweight querying and filtering of the content in the change logs. | ||
|
|
||
| The only other prerequisite for enabling change logs is that the provider must |
There was a problem hiding this comment.
i see folks asking how to detect if a provider includes the changelog feature. In the meantime, could we add a link tomain.go example from the provider-kubernetes project to help illustrate this? https://github.com/crossplane-contrib/provider-kubernetes/blob/3e694c4f2b644664167e67c58f3de8d2f9ffba0f/cmd/provider/main.go#L76
There was a problem hiding this comment.
yeah i was thinking that was going to be a likely question also 😂 - but i don't love the idea of having people go search through source code of their providers
another idea could be to look at the help output of the provider image, e.g.:
❯ docker run --rm xpkg.crossplane.io/crossplane-contrib/provider-kubernetes:v0.17.1 --help 2>&1 | grep enable-changelogs
❯ docker run --rm xpkg.crossplane.io/crossplane-contrib/provider-kubernetes:v0.18.0 --help 2>&1 | grep enable-changelogs
--[no-]enable-changelogs Enable support for capturing change logs during
There was a problem hiding this comment.
There was some offline discussion on a better long term approach that would allow packages to specify the features they support. That is not happening any time soon (it's just an idea right now), so can we punt on this for the first version of this guide and still get this otherwise very helpful material released on the docs site? 🙏
content/master/guides/change-logs.md
Outdated
| ### Create a resource | ||
|
|
||
| Now that the provider is installed and configured with change logs enabled, | ||
| create a resource that will generates change logs entries reflecting the actions |
There was a problem hiding this comment.
| create a resource that will generates change logs entries reflecting the actions | |
| create a resource that will generate change logs entries reflecting the actions |
There was a problem hiding this comment.
thanks @jeanduplessis for the review! i fixed this grammar issue 🙇♂️
Signed-off-by: Jared Watts <[email protected]>
This PR adds a guide for enabling and using the change logs feature. It walks through a simple scenario with
provider-kubernetesto enable change logs on the provider, create some resources and perform lifecycle operations on them, and how to check the change logs to learn more about the operations that were recorded.I encourage reviewers to walk through the guide on the preview site and verify it works for them too. I have done so multiple times on my machine, but it would be good to get further validation.
Fixed #806